Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

doc: linkify missing types #18444

Closed
wants to merge 1 commit into from
Closed

doc: linkify missing types #18444

wants to merge 1 commit into from

Conversation

vsemozhetbyt
Copy link
Contributor

@vsemozhetbyt vsemozhetbyt commented Jan 30, 2018 •
edited
Loading

Checklist
  • make -j4 test (UNIX), or vcbuild test (Windows) passes
  • documentation is changed or added
  • commit message follows commit guidelines
Affected core subsystem(s)

doc, tools

Also, alphabetize all types in type-parser.js and fix some nits in type formats.

Notes:

  1. Custom types in type-parser.js were already grouped by module/subsystem, ASCII order being set inside each group.

  2. I am not sure about 2 types: this (is it OK to link in this way?) and AsyncHook (we have no class chapter in the doc, so I've linked to the async_hooks.createHook() function which creates an instance; please, propose a better solution).

  3. These types have been added (the rest of non-linkified types were just fixed according to the already available types):

    {this}
{AsyncHook}
{crypto.constants}
{Domain}
{fs.Stats}
{ClientHttp2Stream}
{http2.Http2ServerRequest}
{http2.Http2ServerResponse}
{Http2Server}
{Http2Session}
{Http2Stream}
{net.Server}
{os.constants.dlopen}
{PerformanceObserver}
{PerformanceObserverEntryList}
{readline.Interface}
{Immediate}
{Timeout}
{tls.Server}

@vsemozhetbyt
doc: linkify missing types
2c3685d 
Also, alphabetize all types in type-parser.js
and fix some nits in type formats.
@nodejs-github-bot nodejs-github-bot added doc Issues and PRs related to the documentations. tools Issues and PRs related to the tools directory. labels Jan 30, 2018
@vsemozhetbyt
Copy link
Contributor Author

vsemozhetbyt commented Jan 30, 2018 •
edited
Loading

CI-lite: https://ci.nodejs.org/job/node-test-pull-request-lite/133/

@vsemozhetbyt
Copy link
Contributor Author

I cannot understand what is wrong with linter job(

@apapirovski
Copy link
Member

@vsemozhetbyt not your fault, see #18445

@apapirovski
Copy link
Member

CI: https://ci.nodejs.org/job/node-test-pull-request-lite/135/

@vsemozhetbyt
Copy link
Contributor Author

Landed in fd3a0cf

vsemozhetbyt added a commit that referenced this pull request Feb 1, 2018
@vsemozhetbyt
doc: linkify missing types
fd3a0cf 
Also, alphabetize all types in type-parser.js
and fix some nits in type formats.

PR-URL: #18444
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
@vsemozhetbyt vsemozhetbyt deleted the doc-link-types branch February 1, 2018 00:54
@vsemozhetbyt vsemozhetbyt mentioned this pull request Feb 6, 2018
Closed
3 tasks
vsemozhetbyt added a commit that referenced this pull request Feb 6, 2018
@vsemozhetbyt
tools: add FileHandle to doc/type-parser.js
bff5d5b 
PR-URL: #18601
Refs: #18407
Refs: #18444
Reviewed-By: Anatoli Papirovski <apapirovski@mac.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
MylesBorins pushed a commit that referenced this pull request Feb 20, 2018
@vsemozhetbyt @MylesBorins
doc: linkify missing types
3e6609b 
Also, alphabetize all types in type-parser.js
and fix some nits in type formats.

PR-URL: #18444
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
MylesBorins pushed a commit that referenced this pull request Feb 21, 2018
@vsemozhetbyt @MylesBorins
doc: linkify missing types
0d6476b 
Also, alphabetize all types in type-parser.js
and fix some nits in type formats.

PR-URL: #18444
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
MylesBorins pushed a commit that referenced this pull request Feb 21, 2018
@vsemozhetbyt @MylesBorins
doc: linkify missing types
ae372f0 
Also, alphabetize all types in type-parser.js
and fix some nits in type formats.

PR-URL: #18444
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
@MylesBorins MylesBorins mentioned this pull request Feb 21, 2018
Merged
@MylesBorins
Copy link
Contributor

Should this be backported to v8.x-staging or v6.x-staging? If yes please follow the guide and raise a backport PR, if not let me know or add the dont-land-on label.

@vsemozhetbyt vsemozhetbyt mentioned this pull request Mar 20, 2018
Closed
3 tasks
@vsemozhetbyt
Copy link
Contributor Author

v8 backport: #19498

MylesBorins pushed a commit that referenced this pull request Mar 21, 2018
@vsemozhetbyt @MylesBorins
doc: linkify missing types
652abaf 
Also, alphabetize all types in type-parser.js
and fix some nits in type formats.

Backport-PR-URL: #19498
PR-URL: #18444
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
@vsemozhetbyt vsemozhetbyt mentioned this pull request Mar 21, 2018
Closed
3 tasks
@vsemozhetbyt
Copy link
Contributor Author

v6.x backport: #19500

MylesBorins pushed a commit that referenced this pull request Mar 21, 2018
@vsemozhetbyt @MylesBorins
doc: linkify missing types
fe477e4 
Also, alphabetize all types in type-parser.js
and fix some nits in type formats.

Backport-PR-URL: #19500
PR-URL: #18444
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
MylesBorins pushed a commit that referenced this pull request Mar 28, 2018
@vsemozhetbyt @MylesBorins
doc: linkify missing types
4444802 
Also, alphabetize all types in type-parser.js
and fix some nits in type formats.

Backport-PR-URL: #19500
PR-URL: #18444
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
MylesBorins pushed a commit that referenced this pull request Mar 28, 2018
@vsemozhetbyt @MylesBorins
doc: linkify missing types
d503427 
Also, alphabetize all types in type-parser.js
and fix some nits in type formats.

Backport-PR-URL: #19498
PR-URL: #18444
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
MylesBorins pushed a commit that referenced this pull request Mar 30, 2018
@vsemozhetbyt @MylesBorins
doc: linkify missing types
bc2f0a5 
Also, alphabetize all types in type-parser.js
and fix some nits in type formats.

Backport-PR-URL: #19500
PR-URL: #18444
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
MylesBorins pushed a commit that referenced this pull request Mar 30, 2018
@vsemozhetbyt @MylesBorins
doc: linkify missing types
1091dfc 
Also, alphabetize all types in type-parser.js
and fix some nits in type formats.

Backport-PR-URL: #19498
PR-URL: #18444
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
@MylesBorins MylesBorins mentioned this pull request Apr 13, 2018
Merged
@MylesBorins MylesBorins mentioned this pull request May 2, 2018
Merged
MayaLekova pushed a commit to MayaLekova/node that referenced this pull request May 8, 2018
@vsemozhetbyt @MayaLekova
doc: linkify missing types
238b33f 
Also, alphabetize all types in type-parser.js
and fix some nits in type formats.

PR-URL: nodejs#18444
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>
MayaLekova pushed a commit to MayaLekova/node that referenced this pull request May 8, 2018
@vsemozhetbyt @MayaLekova
tools: add FileHandle to doc/type-parser.js
df2fb94 
PR-URL: nodejs#18601
Refs: nodejs#18407
Refs: nodejs#18444
Reviewed-By: Anatoli Papirovski <apapirovski@mac.com>
Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
Reviewed-By: Colin Ihrig <cjihrig@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@lpinca lpinca lpinca approved these changes

@jasnell jasnell jasnell approved these changes

Assignees
No one assigned
Labels
doc Issues and PRs related to the documentations. tools Issues and PRs related to the tools directory.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
6 participants
@vsemozhetbyt @apapirovski @MylesBorins @jasnell @lpinca @nodejs-github-bot